Improve documentation

diff --git a/gtk/a11y/gtkatspicontext.c b/gtk/a11y/gtkatspicontext.c
index c915281722b8ecf182073ed983b911f0b76c2903..67d9623ece4a94e548e6860e077d5be703562bd9 100644 (file)
--- a/gtk/a11y/gtkatspicontext.c
+++ b/gtk/a11y/gtkatspicontext.c
@@ -82,6 +82,10 @@
  *   hold the TAB_PANEL role and be the target of the CONTROLS
  *   relation with their corresponding tabs (in the stack
  *   switcher or notebook).
+ * 
+ * These are the exceptions implemented by GTK itself, but note that application
+ * developers can customize the accessibility tree by implementing the
+ * GtkAccessible interface in any way they choose.
  */
 
 struct _GtkAtSpiContext

diff --git a/gtk/gtkaccessible.c b/gtk/gtkaccessible.c
index 3fd0142cd67bc4ff251e79644ccab4fb3c59d173..a3a05acd56481ecef31d7307b404240e29a244fb 100644 (file)
--- a/gtk/gtkaccessible.c
+++ b/gtk/gtkaccessible.c
@@ -37,6 +37,13 @@
  * a way that should be reflected by assistive technologies. For instance,
  * if a `GtkWidget` visibility changes, the %GTK_ACCESSIBLE_STATE_HIDDEN
  * state will also change to reflect the [property@Gtk.Widget:visible] property.
+ * 
+ * Every accessible implementation is part of a tree of accessible objects.
+ * Normally, this tree corresponds to the widget tree, but can be customized
+ * by reimplementing the #GtkAccessibleInterface.get_parent()
+ * and #GtkAccessibleInterface.get_child_at_index() methods.
+ * Note that you can not create a top-level accessible object as of now,
+ * which means that you must always have a parent accessible object.
  */
 
 #include "config.h"

diff --git a/gtk/gtkaccessible.h b/gtk/gtkaccessible.h
index 4cbd9c34eeeac7f6c9a0ed5c684fdb3f3ea379c4..36b3f08cb074488612c772a8899f831aac62a9f9 100644 (file)
--- a/gtk/gtkaccessible.h
+++ b/gtk/gtkaccessible.h
@@ -35,12 +35,24 @@ G_BEGIN_DECLS
 GDK_AVAILABLE_IN_ALL
 G_DECLARE_INTERFACE (GtkAccessible, gtk_accessible, GTK, ACCESSIBLE, GObject)
 
+/**
+ * GtkAccessiblePlatformState:
+ * 
+ * The various platform states which can be queried
+ * using @gtk_accessible_get_platform_state
+ */
 typedef enum {
   GTK_ACCESSIBLE_PLATFORM_STATE_FOCUSABLE,
   GTK_ACCESSIBLE_PLATFORM_STATE_FOCUSED,
   GTK_ACCESSIBLE_PLATFORM_STATE_ACTIVE
 } GtkAccessiblePlatformState;
 
+/**
+ * GtkAccessiblePlatformChange:
+ *
+ * Represents the various platform changes which can occur and are communicated
+ * using @gtk_accessible_platform_changed.
+ */
 typedef enum {
   GTK_ACCESSIBLE_PLATFORM_CHANGE_FOCUSABLE = 1 << GTK_ACCESSIBLE_PLATFORM_STATE_FOCUSABLE,
   GTK_ACCESSIBLE_PLATFORM_CHANGE_FOCUSED   = 1 << GTK_ACCESSIBLE_PLATFORM_STATE_FOCUSED,
@@ -51,14 +63,59 @@ struct _GtkAccessibleInterface
 {
   GTypeInterface g_iface;
 
+  /**
+   * GtkAccessibleInterface::get_at_context:
+   * @self: a `GtkAccessible`
+   * 
+   * Retrieves the `GtkATContext` for this accessible implementation.
+   */
   GtkATContext *        (* get_at_context)      (GtkAccessible *self);
 
+  /**
+   * GtkAccessibleInterface::get_platform_state:
+   * 
+   * @self: A `GtkAccessible`
+   * @state: The state to retrieve
+   * 
+   * Returns whether @self has the given platform state.
+   * @returns: %true if @state is active for @self.
+   * @returns:
+   */
   gboolean              (* get_platform_state)  (GtkAccessible              *self,
                                                  GtkAccessiblePlatformState  state);
 
+  /**
+   * GtkAccessibleInterface::get_parent:
+   * @self: a `GtkAccessible`
+   * 
+   * Returns the parent `GtkAccessible` of @self.
+   * Be sure not to return %NULL, as a top-level `GtkAccessible` which is not a
+   * top-level window is not supported.
+   */
   GtkAccessible *       (* get_parent)  (GtkAccessible *self);
+  
+  /**
+   * GtkaccessibleInterface::get_child_at_index:
+   * @self: a `GtkAccessible`
+   * @index: the index of the child
+   * 
+   * Returns the child of @self whose position corresponds to @index.
+   * If @index is not valid for @self's children, return -1.
+   */
   GtkAccessible *       (* get_child_at_index)  (GtkAccessible *self, guint index);
 
+  /**
+   * GtkAccessibleInterface::get_bounds:
+   * @self: a `GtkAccessible`
+   * @x: an addres of the x coordinate
+   * @y: an address of the y coordinate
+   * @width: address of the width
+   * @height: address of the height
+   * 
+   * Returns the dimensions and position of @self, if this information
+   * can be determined.
+   * @returns: %true if the values are valid, %false otherwise
+   */
   gboolean              (* get_bounds) (GtkAccessible *self, int *x, int *y,
                                         int *width, int *height);
 };